{{/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
*/}}
<table class="configuration table table-bordered">
    <thead>
        <tr>
            <th class="text-left" style="width: 20%">Key</th>
            <th class="text-left" style="width: 15%">Default</th>
            <th class="text-left" style="width: 10%">Type</th>
            <th class="text-left" style="width: 55%">Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><h5>auto-create</h5></td>
            <td style="word-wrap: break-word;">false</td>
            <td>Boolean</td>
            <td>Whether to create underlying storage when reading and writing the table.</td>
        </tr>
        <tr>
            <td><h5>bucket</h5></td>
            <td style="word-wrap: break-word;">1</td>
            <td>Integer</td>
            <td>Bucket number for file store.</td>
        </tr>
        <tr>
            <td><h5>bucket-key</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>String</td>
            <td>Specify the paimon distribution policy. Data is assigned to each bucket according to the hash value of bucket-key.<br />If you specify multiple fields, delimiter is ','.<br />If not specified, the primary key will be used; if there is no primary key, the full row will be used.</td>
        </tr>
        <tr>
            <td><h5>changelog-producer</h5></td>
            <td style="word-wrap: break-word;">none</td>
            <td><p>Enum</p></td>
            <td>Whether to double write to a changelog file. This changelog file keeps the details of data changes, it can be read directly during stream reads.<br /><br />Possible values:<ul><li>"none": No changelog file.</li><li>"input": Double write to a changelog file when flushing memory table, the changelog is from input.</li><li>"full-compaction": Generate changelog files with each full compaction.</li><li>"lookup": Generate changelog files through 'lookup' before committing the data writing.</li></ul></td>
        </tr>
        <tr>
            <td><h5>commit.force-compact</h5></td>
            <td style="word-wrap: break-word;">false</td>
            <td>Boolean</td>
            <td>Whether to force a compaction before commit.</td>
        </tr>
        <tr>
            <td><h5>compaction.max-size-amplification-percent</h5></td>
            <td style="word-wrap: break-word;">200</td>
            <td>Integer</td>
            <td>The size amplification is defined as the amount (in percentage) of additional storage needed to store a single byte of data in the merge tree for changelog mode table.</td>
        </tr>
        <tr>
            <td><h5>compaction.max-sorted-run-num</h5></td>
            <td style="word-wrap: break-word;">2147483647</td>
            <td>Integer</td>
            <td>The maximum sorted run number to pick for compaction. This value avoids merging too much sorted runs at the same time during compaction, which may lead to OutOfMemoryError.</td>
        </tr>
        <tr>
            <td><h5>compaction.max.file-num</h5></td>
            <td style="word-wrap: break-word;">50</td>
            <td>Integer</td>
            <td>For file set [f_0,...,f_N], the maximum file number to trigger a compaction for append-only table, even if sum(size(f_i)) &lt; targetFileSize. This value avoids pending too much small files, which slows down the performance.</td>
        </tr>
        <tr>
            <td><h5>compaction.min.file-num</h5></td>
            <td style="word-wrap: break-word;">5</td>
            <td>Integer</td>
            <td>For file set [f_0,...,f_N], the minimum file number which satisfies sum(size(f_i)) &gt;= targetFileSize to trigger a compaction for append-only table. This value avoids almost-full-file to be compacted, which is not cost-effective.</td>
        </tr>
        <tr>
            <td><h5>compaction.size-ratio</h5></td>
            <td style="word-wrap: break-word;">1</td>
            <td>Integer</td>
            <td>Percentage flexibility while comparing sorted run size for changelog mode table. If the candidate sorted run(s) size is 1% smaller than the next sorted run's size, then include next sorted run into this candidate set.</td>
        </tr>
        <tr>
            <td><h5>consumer-id</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>String</td>
            <td>Consumer id for recording the offset of consumption in the storage.</td>
        </tr>
        <tr>
            <td><h5>continuous.discovery-interval</h5></td>
            <td style="word-wrap: break-word;">10 s</td>
            <td>Duration</td>
            <td>The discovery interval of continuous reading.</td>
        </tr>
        <tr>
            <td><h5>dynamic-partition-overwrite</h5></td>
            <td style="word-wrap: break-word;">true</td>
            <td>Boolean</td>
            <td>Whether only overwrite dynamic partition when overwriting a partitioned table with dynamic partition columns. Works only when the table has partition keys.</td>
        </tr>
        <tr>
            <td><h5>file.compression</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>String</td>
            <td>Default file compression format, can be overridden by file.compression.per.level</td>
        </tr>
        <tr>
            <td><h5>file.compression.per.level</h5></td>
            <td style="word-wrap: break-word;"></td>
            <td>Map</td>
            <td>Define different compression policies for different level, you can add the conf like this: 'file.compression.per.level' = '0:lz4,1:zlib', for orc file format, the compression value could be NONE, ZLIB, SNAPPY, LZO, LZ4, for parquet file format, the compression value could be UNCOMPRESSED, SNAPPY, GZIP, LZO, BROTLI, LZ4, ZSTD.</td>
        </tr>
        <tr>
            <td><h5>file.format</h5></td>
            <td style="word-wrap: break-word;">orc</td>
            <td><p>Enum</p></td>
            <td>Specify the message format of data files, currently orc, parquet and avro are supported.<br /><br />Possible values:<ul><li>"orc": ORC file format.</li><li>"parquet": Parquet file format.</li><li>"avro": Avro file format.</li></ul></td>
        </tr>
        <tr>
            <td><h5>full-compaction.delta-commits</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>Integer</td>
            <td>Full compaction will be constantly triggered after delta commits.</td>
        </tr>
        <tr>
            <td><h5>local-sort.max-num-file-handles</h5></td>
            <td style="word-wrap: break-word;">128</td>
            <td>Integer</td>
            <td>The maximal fan-in for external merge sort. It limits the number of file handles. If it is too small, may cause intermediate merging. But if it is too large, it will cause too many files opened at the same time, consume memory and lead to random reading.</td>
        </tr>
        <tr>
            <td><h5>log.changelog-mode</h5></td>
            <td style="word-wrap: break-word;">auto</td>
            <td><p>Enum</p></td>
            <td>Specify the log changelog mode for table.<br /><br />Possible values:<ul><li>"auto": Upsert for table with primary key, all for table without primary key.</li><li>"all": The log system stores all changes including UPDATE_BEFORE.</li><li>"upsert": The log system does not store the UPDATE_BEFORE changes, the log consumed job will automatically add the normalized node, relying on the state to generate the required update_before.</li></ul></td>
        </tr>
        <tr>
            <td><h5>log.consistency</h5></td>
            <td style="word-wrap: break-word;">transactional</td>
            <td><p>Enum</p></td>
            <td>Specify the log consistency mode for table.<br /><br />Possible values:<ul><li>"transactional": Only the data after the checkpoint can be seen by readers, the latency depends on checkpoint interval.</li><li>"eventual": Immediate data visibility, you may see some intermediate states, but eventually the right results will be produced, only works for table with primary key.</li></ul></td>
        </tr>
        <tr>
            <td><h5>log.format</h5></td>
            <td style="word-wrap: break-word;">"debezium-json"</td>
            <td>String</td>
            <td>Specify the message format of log system.</td>
        </tr>
        <tr>
            <td><h5>log.key.format</h5></td>
            <td style="word-wrap: break-word;">"json"</td>
            <td>String</td>
            <td>Specify the key message format of log system with primary key.</td>
        </tr>
        <tr>
            <td><h5>log.scan.remove-normalize</h5></td>
            <td style="word-wrap: break-word;">false</td>
            <td>Boolean</td>
            <td>Whether to force the removal of the normalize node when streaming read. Note: This is dangerous and is likely to cause data errors if downstream is used to calculate aggregation and the input is not complete changelog.</td>
        </tr>
        <tr>
            <td><h5>lookup.cache-file-retention</h5></td>
            <td style="word-wrap: break-word;">1 h</td>
            <td>Duration</td>
            <td>The cached files retention time for lookup. After the file expires, if there is a need for access, it will be re-read from the DFS to build an index on the local disk.</td>
        </tr>
        <tr>
            <td><h5>lookup.cache-max-disk-size</h5></td>
            <td style="word-wrap: break-word;">9223372036854775807 bytes</td>
            <td>MemorySize</td>
            <td>Max disk size for lookup cache, you can use this option to limit the use of local disks.</td>
        </tr>
        <tr>
            <td><h5>lookup.cache-max-memory-size</h5></td>
            <td style="word-wrap: break-word;">256 mb</td>
            <td>MemorySize</td>
            <td>Max memory size for lookup cache.</td>
        </tr>
        <tr>
            <td><h5>lookup.hash-load-factor</h5></td>
            <td style="word-wrap: break-word;">0.75</td>
            <td>Float</td>
            <td>The index load factor for lookup.</td>
        </tr>
        <tr>
            <td><h5>manifest.format</h5></td>
            <td style="word-wrap: break-word;">avro</td>
            <td><p>Enum</p></td>
            <td>Specify the message format of manifest files.<br /><br />Possible values:<ul><li>"orc": ORC file format.</li><li>"parquet": Parquet file format.</li><li>"avro": Avro file format.</li></ul></td>
        </tr>
        <tr>
            <td><h5>manifest.merge-min-count</h5></td>
            <td style="word-wrap: break-word;">30</td>
            <td>Integer</td>
            <td>To avoid frequent manifest merges, this parameter specifies the minimum number of ManifestFileMeta to merge.</td>
        </tr>
        <tr>
            <td><h5>manifest.target-file-size</h5></td>
            <td style="word-wrap: break-word;">8 mb</td>
            <td>MemorySize</td>
            <td>Suggested file size of a manifest file.</td>
        </tr>
        <tr>
            <td><h5>merge-engine</h5></td>
            <td style="word-wrap: break-word;">deduplicate</td>
            <td><p>Enum</p></td>
            <td>Specify the merge engine for table with primary key.<br /><br />Possible values:<ul><li>"deduplicate": De-duplicate and keep the last row.</li><li>"partial-update": Partial update non-null fields.</li><li>"aggregation": Aggregate fields with same primary key.</li></ul></td>
        </tr>
        <tr>
            <td><h5>num-levels</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>Integer</td>
            <td>Total level number, for example, there are 3 levels, including 0,1,2 levels.</td>
        </tr>
        <tr>
            <td><h5>num-sorted-run.compaction-trigger</h5></td>
            <td style="word-wrap: break-word;">5</td>
            <td>Integer</td>
            <td>The sorted run number to trigger compaction. Includes level0 files (one file one sorted run) and high-level runs (one level one sorted run).</td>
        </tr>
        <tr>
            <td><h5>num-sorted-run.stop-trigger</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>Integer</td>
            <td>The number of sorted runs that trigger the stopping of writes, the default value is 'num-sorted-run.compaction-trigger' + 1.</td>
        </tr>
        <tr>
            <td><h5>orc.bloom.filter.columns</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>String</td>
            <td>A comma-separated list of columns for which to create a bloom filter when writing.</td>
        </tr>
        <tr>
            <td><h5>orc.bloom.filter.fpp</h5></td>
            <td style="word-wrap: break-word;">0.05</td>
            <td>Double</td>
            <td>Define the default false positive probability for bloom filters.</td>
        </tr>
        <tr>
            <td><h5>page-size</h5></td>
            <td style="word-wrap: break-word;">64 kb</td>
            <td>MemorySize</td>
            <td>Memory page size.</td>
        </tr>
        <tr>
            <td><h5>partial-update.ignore-delete</h5></td>
            <td style="word-wrap: break-word;">false</td>
            <td>Boolean</td>
            <td>Whether to ignore delete records in partial-update mode.</td>
        </tr>
        <tr>
            <td><h5>partition</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>String</td>
            <td>Define partition by table options, cannot define partition on DDL and table options at the same time.</td>
        </tr>
        <tr>
            <td><h5>partition.default-name</h5></td>
            <td style="word-wrap: break-word;">"__DEFAULT_PARTITION__"</td>
            <td>String</td>
            <td>The default partition name in case the dynamic partition column value is null/empty string.</td>
        </tr>
        <tr>
            <td><h5>partition.expiration-check-interval</h5></td>
            <td style="word-wrap: break-word;">1 h</td>
            <td>Duration</td>
            <td>The check interval of partition expiration.</td>
        </tr>
        <tr>
            <td><h5>partition.expiration-time</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>Duration</td>
            <td>The expiration interval of a partition. A partition will be expired if it‘s lifetime is over this value. Partition time is extracted from the partition value.</td>
        </tr>
        <tr>
            <td><h5>partition.timestamp-formatter</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>String</td>
            <td>The formatter to format timestamp from string. It can be used with 'partition.timestamp-pattern' to create a formatter using the specified value.<ul><li>Default formatter is 'yyyy-MM-dd HH:mm:ss' and 'yyyy-MM-dd'.</li><li>Supports multiple partition fields like '$year-$month-$day $hour:00:00'.</li><li>The timestamp-formatter is compatible with Java's DateTimeFormatter.</li></ul></td>
        </tr>
        <tr>
            <td><h5>partition.timestamp-pattern</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>String</td>
            <td>You can specify a pattern to get a timestamp from partitions. The formatter pattern is defined by 'partition.timestamp-formatter'.<ul><li>By default, read from the first field.</li><li>If the timestamp in the partition is a single field called 'dt', you can use '$dt'.</li><li>If it is spread across multiple fields for year, month, day, and hour, you can use '$year-$month-$day $hour:00:00'.</li><li>If the timestamp is in fields dt and hour, you can use '$dt $hour:00:00'.</li></ul></td>
        </tr>
        <tr>
            <td><h5>primary-key</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>String</td>
            <td>Define primary key by table options, cannot define primary key on DDL and table options at the same time.</td>
        </tr>
        <tr>
            <td><h5>read.batch-size</h5></td>
            <td style="word-wrap: break-word;">1024</td>
            <td>Integer</td>
            <td>Read batch size for orc and parquet.</td>
        </tr>
        <tr>
            <td><h5>scan.bounded.watermark</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>Long</td>
            <td>End condition "watermark" for bounded streaming mode. Stream reading will end when a larger watermark snapshot is encountered.</td>
        </tr>
        <tr>
            <td><h5>scan.mode</h5></td>
            <td style="word-wrap: break-word;">default</td>
            <td><p>Enum</p></td>
            <td>Specify the scanning behavior of the source.<br /><br />Possible values:<ul><li>"default": Determines actual startup mode according to other table properties. If "scan.timestamp-millis" is set the actual startup mode will be "from-timestamp", and if "scan.snapshot-id" is set the actual startup mode will be "from-snapshot". Otherwise the actual startup mode will be "latest-full".</li><li>"latest-full": For streaming sources, produces the latest snapshot on the table upon first startup, and continue to read the latest changes. For batch sources, just produce the latest snapshot but does not read new changes.</li><li>"full": Deprecated. Same as "latest-full".</li><li>"latest": For streaming sources, continuously reads latest changes without producing a snapshot at the beginning. For batch sources, behaves the same as the "latest-full" startup mode.</li><li>"compacted-full": For streaming sources, produces a snapshot after the latest compaction on the table upon first startup, and continue to read the latest changes. For batch sources, just produce a snapshot after the latest compaction but does not read new changes. Snapshots of full compaction are picked when scheduled full-compaction is enabled.</li><li>"from-timestamp": For streaming sources, continuously reads changes starting from timestamp specified by "scan.timestamp-millis", without producing a snapshot at the beginning. For batch sources, produces a snapshot at timestamp specified by "scan.timestamp-millis" but does not read new changes.</li><li>"from-snapshot": For streaming sources, continuously reads changes starting from snapshot specified by "scan.snapshot-id", without producing a snapshot at the beginning. For batch sources, produces a snapshot specified by "scan.snapshot-id" but does not read new changes.</li><li>"from-snapshot-full": For streaming sources, produces from snapshot specified by "scan.snapshot-id" on the table upon first startup, and continuously reads changes. For batch sources, produces a snapshot specified by "scan.snapshot-id" but does not read new changes.</li></ul></td>
        </tr>
        <tr>
            <td><h5>scan.plan-sort-partition</h5></td>
            <td style="word-wrap: break-word;">false</td>
            <td>Boolean</td>
            <td>Whether to sort plan files by partition fields, this allows you to read according to the partition order, even if your partition writes are out of order.<br />It is recommended that you use this for streaming read of the 'append-only' table. By default, streaming read will read the full snapshot first. In order to avoid the disorder reading for partitions, you can open this option.</td>
        </tr>
        <tr>
            <td><h5>scan.snapshot-id</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>Long</td>
            <td>Optional snapshot id used in case of "from-snapshot" or "from-snapshot-full" scan mode</td>
        </tr>
        <tr>
            <td><h5>scan.timestamp-millis</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>Long</td>
            <td>Optional timestamp used in case of "from-timestamp" scan mode.</td>
        </tr>
        <tr>
            <td><h5>sequence.field</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>String</td>
            <td>The field that generates the sequence number for primary key table, the sequence number determines which data is the most recent.</td>
        </tr>
        <tr>
            <td><h5>snapshot.num-retained.max</h5></td>
            <td style="word-wrap: break-word;">2147483647</td>
            <td>Integer</td>
            <td>The maximum number of completed snapshots to retain.</td>
        </tr>
        <tr>
            <td><h5>snapshot.num-retained.min</h5></td>
            <td style="word-wrap: break-word;">10</td>
            <td>Integer</td>
            <td>The minimum number of completed snapshots to retain.</td>
        </tr>
        <tr>
            <td><h5>snapshot.time-retained</h5></td>
            <td style="word-wrap: break-word;">1 h</td>
            <td>Duration</td>
            <td>The maximum time of completed snapshots to retain.</td>
        </tr>
        <tr>
            <td><h5>source.split.open-file-cost</h5></td>
            <td style="word-wrap: break-word;">4 mb</td>
            <td>MemorySize</td>
            <td>Open file cost of a source file. It is used to avoid reading too many files with a source split, which can be very slow.</td>
        </tr>
        <tr>
            <td><h5>source.split.target-size</h5></td>
            <td style="word-wrap: break-word;">128 mb</td>
            <td>MemorySize</td>
            <td>Target size of a source split when scanning a bucket.</td>
        </tr>
        <tr>
            <td><h5>streaming-read-mode</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td><p>Enum</p></td>
            <td>The mode of streaming read that specifies to read the data of table file or log<br /><br />Possible values:<br /><ul><li>file: Reads from the data of table file store.</li></ul><ul><li>log: Read from the data of table log store.</li></ul><br /><br />Possible values:<ul><li>"log": Reads from the log store.</li><li>"file": Reads from the file store.</li></ul></td>
        </tr>
        <tr>
            <td><h5>streaming-read-overwrite</h5></td>
            <td style="word-wrap: break-word;">false</td>
            <td>Boolean</td>
            <td>Whether to read the changes from overwrite in streaming mode.</td>
        </tr>
        <tr>
            <td><h5>target-file-size</h5></td>
            <td style="word-wrap: break-word;">128 mb</td>
            <td>MemorySize</td>
            <td>Target size of a file.</td>
        </tr>
        <tr>
            <td><h5>write-buffer-size</h5></td>
            <td style="word-wrap: break-word;">256 mb</td>
            <td>MemorySize</td>
            <td>Amount of data to build up in memory before converting to a sorted on-disk file.</td>
        </tr>
        <tr>
            <td><h5>write-buffer-spillable</h5></td>
            <td style="word-wrap: break-word;">(none)</td>
            <td>Boolean</td>
            <td>Whether the write buffer can be spillable. Enabled by default when using object storage.</td>
        </tr>
        <tr>
            <td><h5>write-manifest-cache</h5></td>
            <td style="word-wrap: break-word;">0 bytes</td>
            <td>MemorySize</td>
            <td>Cache size for reading manifest files for write initialization.</td>
        </tr>
        <tr>
            <td><h5>write-mode</h5></td>
            <td style="word-wrap: break-word;">auto</td>
            <td><p>Enum</p></td>
            <td>Specify the write mode for table.<br /><br />Possible values:<ul><li>"auto": The change-log for table with primary key, append-only for table without primary key.</li><li>"append-only": The table can only accept append-only insert operations. Neither data deduplication nor any primary key constraints will be done when inserting rows into paimon.</li><li>"change-log": The table can accept insert/delete/update operations.</li></ul></td>
        </tr>
        <tr>
            <td><h5>write-only</h5></td>
            <td style="word-wrap: break-word;">false</td>
            <td>Boolean</td>
            <td>If set to true, compactions and snapshot expiration will be skipped. This option is used along with dedicated compact jobs.</td>
        </tr>
    </tbody>
</table>
